CCM-7478: Enable Test Coverage Reporting in Sonar#1007

Merged

gareth-allan merged 21 commits into

feature/CCM-7478_sonarqube_test_coverage

Oct 2, 2025

Contributor

gareth-allan commented Sep 29, 2025 •

edited

Loading

Summary

This PR enables reporting of test coverage metrics in SonarCloud.

Changes:

Added commands to the Test sandbox server step of the build workflow that use the lcov-result-merger package (as used in the nhs-notify-repository-template repository) to generate an lcov.info file with the correct file paths for Sonar to interpret
Updated the Sonar configuration (scripts/config/sonar-scanner.properties) to:
- Specify that the Sonar scan should wait for the quality gate result and fail the build if it fails
- Set the appropriate source/test paths
- Configure test coverage reporting
Removed an unused mocha-multi package from the sandbox application

Verification

Verified in the build output that the lcov.info file is being read as part of the Sonar scan:

Verified in the build output that the scan is waiting for the quality gate results:

(Also, see df79145 for a commit which was deliberately failing the quality gate.)

Verified that the Sonar dashboard is (attempting) to show coverage:

Note that the message given for another branch, without the changes in this PR tells us coverage reporting isn't enabled:

Reviews Required

Dev
Test
Tech Author
Product Owner

Checklist

Brief description of work completed, and any technical decisions made as part of the PR
PR link added as a comment to the relevant JIRA ticket
PR link shared on Slack and/or Teams
2 reviews received
Tester approval

gareth-allan added 12 commits

September 19, 2025 16:55


          CCM-7478: Remove unnecessary sandbox dependency

ef66882


          CCM-7478: Configure test coverage reporting

d5ffc92


          CCM-7478: Try to fix coverage path

5e82989


          CCM-7478: Add debug

db90384


          CCM-7478: Remove debug again

3a1ce51


          CCM-7478: Rewrite LCOV file for correct paths

dfa0fc4


          CCM-7478: Tweak coverage generation

de89956


          CCM-7478: Don't set Node.js path for Sonar

a3622a4


          Enable debug mode for Sonar scan

94bf92e


          CCM-7478: Try disabling coverage exclusions

71335ae


          Merge branch 'release' into feature/CCM-7478_sonarqube_test_coverage

a825808


          CCM-7478: Specify test files to Sonar

dc56cd5

gareth-allan changed the title ~~Feature/ccm 7478 sonarqube test coverage~~ CCM-7478: Enable Test Coverage Reporting in Sonar

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Attempt to fail Sonar quality gate

b596fec

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Further attempts to break Sonar

7ff1310

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Further attempt to fail Sonar quality gate

e56ce99

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Try adding a sonar.sources property

fd86be5

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Remove sonar.tests property

c066b32

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Make Sonar scan fail if quality gate fails

df79145

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478


          CCM-7478: Attempt to configure test files again

e267f3a

github-actions Bot commented Sep 29, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478

gareth-allan added 2 commits

September 30, 2025 09:16


          CCM-7478: Remove deliberate Sonar failure

4f983d5


          CCM-7478: Disable Sonar debug output

5e582ac

github-actions Bot commented Sep 30, 2025

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-7478

gareth-allan commented

View reviewed changes

scripts/config/sonar-scanner.properties

gareth-allan marked this pull request as ready for review

September 30, 2025 09:48

simonlabarere approved these changes

View reviewed changes

tdroza-nhs approved these changes

View reviewed changes

gareth-allan merged commit f09023b into release

6 checks passed

gareth-allan deleted the feature/CCM-7478_sonarqube_test_coverage branch

October 2, 2025 09:29

Kennedy1265 pushed a commit that referenced this pull request


          CCM-7478: Enable Test Coverage Reporting in Sonar (#1007)

e8fbcef

* CCM-7478: Remove unnecessary sandbox dependency

* CCM-7478: Configure test coverage reporting

* CCM-7478: Don't set Node.js path for Sonar

* CCM-7478: Make Sonar scan fail if quality gate fails

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet